Documentation In Scripts
Docular parses your script files ( designated in your Grunt config ), and looks for documentation that live within blocked comments. A block comment looks like this:
/** * This is a block comment */ /** * This is a multi * line block comment */
Here is an example of Docular documentation within comment blocks within a script file:
//this comment is ignored because it is not in a block /** * @doc function * @name myModule.moduleSection:thisIsAFunction * * @description This function rules! * * This is still part of the description!!! */ var thisIsAFunction = function () {};
So here are a few points to note: